home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-04 / dm3_doc.zip / DM3.DOC < prev    next >
Text File  |  1990-04-06  |  16KB  |  328 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.         M Y C R O F T   S Y S T E M S   D O O R   I / O   L I B R A R Y
  31.  
  32.                                   Users Manual
  33.  
  34.                             for version 3.00 04/06/90
  35.  
  36.  
  37.  
  38.                                I M P O R T A N T
  39.  
  40.      This document is just a working template for the DM library version
  41.      3.00 code.  It lists a tentative functions as currently planned.  Note
  42.      that using this version of the library you will have to adapt from
  43.      time to time as new releases are made, or generate "freeze" versions
  44.      for use with a door you are working on.
  45.  
  46.      In general refer to the file DM.DOC for current function documentation.
  47.      I will try to keep this as up to date as possible.  Please note that
  48.      since this is a "pre-release" and will not be totally stable that you
  49.      should not distribute the library in any form.
  50.  
  51.      At present, I hope to have a full 3.xx ready to use sometime during the
  52.      summer.  For now you should find the existing routines are more than
  53.      adequate to write doors with.  With version 3.00 we have changed the
  54.      I/O from BIOS calls to direct interrupt driven access (or optionally to
  55.      use a fossil driver) with full high speed modem support.
  56.  
  57.      Should you have any any questions, please feel free to contact me on
  58.      the BBS at (408)927-0105, or voice Mon-Sat 10:00a to 7:00p PST at
  59.      (408)268-7981.
  60.  
  61.  
  62.                                                                           i
  63.  
  64.                         T A B L E   O F   C O N T E N T S
  65.  
  66.  
  67.  
  68.      DISCLAIMER  . . . . . . . . . . . . . . . . . . . . . . . . . . . .   i
  69.  
  70.      USER NOTICE . . . . . . . . . . . . . . . . . . . . . . . . . . . .   i
  71.  
  72.      LICENSE AGREEMENT . . . . . . . . . . . . . . . . . . . . . . . . .   i
  73.  
  74.      Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . . .   x
  75.  
  76.      Distribution files. . . . . . . . . . . . . . . . . . . . . . . . .   x
  77.  
  78.      Compiling the library . . . . . . . . . . . . . . . . . . . . . . .   x
  79.  
  80.      Compatibility with previous versions. . . . . . . . . . . . . . . .   x
  81.  
  82.      The include files . . . . . . . . . . . . . . . . . . . . . . . . .   x
  83.  
  84.      The libraries . . . . . . . . . . . . . . . . . . . . . . . . . . .   x
  85.  
  86.      Theory and authors notes. . . . . . . . . . . . . . . . . . . . . .   x
  87.         Standard command line format                                       x
  88.         BIOS, Fossil, Direct & Interrupt I/O                               x
  89.         Shared file access                                                 x
  90.         Managing multiple sessions                                         x
  91.         Inter node communication                                           x
  92.         SysOp keys                                                         x
  93.         Automated Installation Utility                                     x
  94.         Bug Report Utility                                                 x
  95.         BBS interfaces and default values                                  x
  96.         Giving the SysOp some control                                      x
  97.         Serialization & program security                                   x
  98.  
  99.      The sample programs . . . . . . . . . . . . . . . . . . . . . . . .   x
  100.         BBSInfo               Simple BBS information dump                  x
  101.         Jokes                 Sample multilingual message base             x
  102.         MasterMind            Sample game with user file interface         x
  103.         Opinion               Sample menu usage                            x
  104.         RBE                   Sample editor usage                          x
  105.         Shell                 A minimal DOS shell                          x
  106.         Template              Template for new doors                       x
  107.  
  108.      DM initialization . . . . . . . . . . . . . . . . . . . . . . . . .   x
  109.         DM_Init               (new)           Initialize DM library        x
  110.         DM_Close              (new)           Release all resources & exit x
  111.         DM_Credits            (new)           Show author credits          x
  112.  
  113.      Low level modem services. . . . . . . . . . . . . . . . . . . . . .   x
  114.         DM_ModemCarrier       MODEM_CARRIER   Test for carrier detect      x
  115.         DM_ModemStatus        MODEM_STATUS    Test for modem character     x
  116.         DM_ModemInput         MODEM_INPUT     Input chara from modem       x
  117.         DM_ModemOutput        MODEM_OUTPUT    Output char to modem         x
  118.  
  119.      Low level local services. . . . . . . . . . . . . . . . . . . . . .   x
  120.         DM_LocalStatus        LOCAL_STATUS    Test for local character     x
  121.         DM_LocalInput         LOCAL_INPUT     Input char from local CRT    x
  122.         DM_LocalOutput        LOCAL_OUTPUT    Output char to local screen  x
  123.  
  124.      Additional local services . . . . . . . . . . . . . . . . . . . . .   x
  125.         DM_LocalCls           LOCAL_CLS       Clear local display          x
  126.         DM_LocalBell          LOCAL_BELL      Ring local bell              x
  127.         DM_LocalPrint         LOCAL_PRINT     Print local message          x
  128.         DM_GetLocalCursor     GET_LOCAL_CURSORGet local cursor position    x
  129.         DM_SetLocalCursor     SET_LOCAL_CURSORSet local cursor position    x
  130.         DM_LocalCursorStyle   NO_CURSOR       Set local cursor size        x
  131.            "                  SMALL_CURSOR
  132.            "                  MEDIUM_CURSOR
  133.            "                  LARGE_CURSOR
  134.         DM_SetBanner          SET_LOCAL_BANNERInitialize program banner    x
  135.         DM_PutBanner          PUT_LOCAL_BANNERDisplay local banner         x
  136.  
  137.      Main I/O services . . . . . . . . . . . . . . . . . . . . . . . . .   x
  138.         DM_IoTests            IO_TESTS        Test virtual console errors  x
  139.         DM_IoStatus           IO_STATUS       Test virtual console status  x
  140.         DM_IoInput            IO_INPUT        Input from virtual console   x
  141.         DM_IoOutput           PRINT_CHAR      Output to virtual console    x
  142.            "                  PRINT_CHARX
  143.  
  144.      Keyboard services . . . . . . . . . . . . . . . . . . . . . . . . .   x
  145.         DM_IoLineInput        IO_LINPUT       Read a line from virtual c.  x
  146.            "                  IO_LXINPUT
  147.            "                  IO_LEXINPUT
  148.  
  149.      Screen control services . . . . . . . . . . . . . . . . . . . . . .   x
  150.         DM_IoPositionCursor   POSITION_CURSOR Position cursor              x
  151.         DM_IoCls              CLS_DISPLAY     Clear screen                 x
  152.            "                  CLS2_DISPLAY
  153.         DM_IoErase            (new)           Erase rectangle              x
  154.         DM_IoEol              EOL_DISPLAY     Erase to end of line         x
  155.         DM_IoSave             (new)           Save a section of the screen x
  156.         DM_IoRestore          (new)           Restore a section of the scr x
  157.         DM_IoShadow           (new)           Enable/disable shadowing     x
  158.  
  159.      Color control . . . . . . . . . . . . . . . . . . . . . . . . . . .   x
  160.         DM_Color              (new)           Setup color table            x
  161.         DM_SetColors          (new)           Select a color set           x
  162.  
  163.      Message services. . . . . . . . . . . . . . . . . . . . . . . . . .   x
  164.         DM_IoPrint            PRINT_STRING    Print string to vir. console x
  165.         DM_IoGetMessage       (new)           Get a message pointer        x
  166.         DM_IoPrintMessage     (new)           Print msg to virtual console x
  167.         DM_IoPrintFile        PRINT_METERED   Print file to vir. console   x
  168.            "                  PRINT_METEREDX
  169.         DM_IoBackup           BACKUP          Backup/erase                 x
  170.         DM_IoPause            IO_PAUSE        Wait for key with message    x
  171.  
  172.      Drawing services. . . . . . . . . . . . . . . . . . . . . . . . . .   x
  173.         DM_IoLine             (new)           Draw a line                  x
  174.         DM_IoBox              (new)           Draw a box                   x
  175.  
  176.      ANSI menus. . . . . . . . . . . . . . . . . . . . . . . . . . . . .   x
  177.         DM_Menu               (new)           Invoke ANSI menu             x
  178.  
  179.      ANSI editor . . . . . . . . . . . . . . . . . . . . . . . . . . . .   x
  180.         DM_Edit               (new)           Edit a block message         x
  181.         DM_EditFile           (new)           Edit a file                  x
  182.  
  183.      Shared file services. . . . . . . . . . . . . . . . . . . . . . . .   x
  184.         DM_FileOpen           FILE_OPEN       Open a shared file           x
  185.         DM_FileClose          FILE_CLOSE      Close a shared file          x
  186.         DM_FileChange         FILE_CHANGE     Change shared file access    x
  187.         DM_FileReset          FILE_RESET      Reset shared file access     x
  188.         DM_FileLog            (new)           Log message to file          x
  189.  
  190.      Error processing services . . . . . . . . . . . . . . . . . . . . .   x
  191.         DM_ErrorLog           (new)           Log error to file            x
  192.         DM_ErrorProcess       (new)           Process standard errors      x
  193.  
  194.      Inter node communication services . . . . . . . . . . . . . . . . .   x
  195.  
  196.      Multiple session services . . . . . . . . . . . . . . . . . . . . .   x
  197.  
  198.      File & directory services . . . . . . . . . . . . . . . . . . . . .   x
  199.         DM_FileGDta           GET_DTA         Get disk transfer address    x
  200.         DM_FileSDta           SET_DTA         Set disk transfer address    x
  201.         DM_FileTest           (new)           Test if file exists          x
  202.         DM_FileCKS            (new)           Get 16 bit checksum          x
  203.         DM_FileSearch         FSEARCH         Find matching files          x
  204.         DM_DirSearch          DSEARCH         Find matching directories    x
  205.         DM_FileHide           FHIDE           Hide a specified file        x
  206.         DM_FileUnHide         FUNHIDE         Unhide a specified file      x
  207.  
  208.      Low level BBS services. . . . . . . . . . . . . . . . . . . . . . .   x
  209.         DM_BbsNodes           IO_OPEN         Read BBS node info file      x
  210.         DM_BbsRbbs            RBBS_READ       Read RBBS 16+ user info      x
  211.         DM_BbsQbbs            QBBS_READ       Read QuickBBS user info      x
  212.         DM_BbsPcb12           PCBBS_READ      Read PCBoard 12.x user info  x
  213.         DM_BbsPcb14           PCBBS2_READ     Read PCBoard 14.x user info  x
  214.         DM_BbsWildcat         WCBBS_READ      Read Wildcat user info       x
  215.         DM_BbsGap             GBBS_READ       Read GAP BBS user info       x
  216.         DM_BbsWwiv            WBBS_READ       Read WWIV user info          x
  217.         DM_Bbs2am             (new)           Read 2AM user info           x
  218.         DM_BbsGtPower         (new)           Read GTPower user info       x
  219.         DM_BbsOpus            (new)           Read Opus user info          x
  220.         DM_BbsPhoenix         (new)           Read Phoenix BBS user info   x
  221.         DM_BbsMilton          (new)           Read Milton Gameworks info   x
  222.         DM_BbsBinary          (new)           Read Binary user info        x
  223.         DM_BbsText            (new)           Read Text user info          x
  224.  
  225.      Main BBS services . . . . . . . . . . . . . . . . . . . . . . . . .   x
  226.         DM_BbsInfo            READ_BBS_INFO   Read BBS user info           x
  227.  
  228.      SysOp and user interaction. . . . . . . . . . . . . . . . . . . . .   x
  229.         DM_SysopPage          PAGE_OPERATOR   Page the SysOp               x
  230.         DM_SysOpChat          CHAT_MODE       Chat with word wrap          x
  231.  
  232.      Net-Mail services . . . . . . . . . . . . . . . . . . . . . . . . .   x
  233.  
  234.      Door Monitor services . . . . . . . . . . . . . . . . . . . . . . .   x
  235.         DM_MonRead            MON_READ        Read monitor config info     x
  236.         DM_MonPlayer          MON_PLAYER      Read monitor user info       x
  237.         DM_MonWrite           MON_WRITE       Write monitor points file    x
  238.         DM_MonExit            MON_EXIT        Exit to monitor              x
  239.  
  240.      Time services . . . . . . . . . . . . . . . . . . . . . . . . . . .   x
  241.         DM_Delay              (new)           Delay n 1/10th seconds       x
  242.         DM_Sleep              SLEEP           Delay n seconds              x
  243.         DM_GetDate            GET_DATE        Get current date             x
  244.         DM_ConvertDays        CVT_DAYS                                     x
  245.         DM_GetTime            CUR_TIME                                     x
  246.         DM_ConvertTime        CVT_TIME                                     x
  247.         DM_Timeout            TEST_TIMEOUT                                 x
  248.         DM_TimeControls       TIME_CONTROLS                                x
  249.         DM_DayControls        DAILY_CONTROLS                               x
  250.  
  251.      SysOp key services. . . . . . . . . . . . . . . . . . . . . . . . .   x
  252.  
  253.      DM data structures. . . . . . . . . . . . . . . . . . . . . . . . .   x
  254.         File access structures . . . . . . . . . . . . . . . . . . . . .   x
  255.         Message access structure . . . . . . . . . . . . . . . . . . . .   x
  256.         Time control structures. . . . . . . . . . . . . . . . . . . . .   x
  257.         User data structures . . . . . . . . . . . . . . . . . . . . . .   x
  258.  
  259.      BBS file structures . . . . . . . . . . . . . . . . . . . . . . . .   x
  260.  
  261.      Monitor data structures . . . . . . . . . . . . . . . . . . . . . .   x
  262.  
  263.      Time definition file format . . . . . . . . . . . . . . . . . . . .   x
  264.  
  265.      Utility programs. . . . . . . . . . . . . . . . . . . . . . . . . .   x
  266.         Timegen utility. . . . . . . . . . . . . . . . . . . . . . . . .   x
  267.         Genmsg utility . . . . . . . . . . . . . . . . . . . . . . . . .   x
  268.         Gencks utility . . . . . . . . . . . . . . . . . . . . . . . . .   x
  269.         Serial utility . . . . . . . . . . . . . . . . . . . . . . . . .   x
  270.  
  271.      The future of the DM library. . . . . . . . . . . . . . . . . . . .   x
  272.  
  273.      Other products from Mycroft Systems . . . . . . . . . . . . . . . .   x
  274.  
  275.      In closing  . . . . . . . . . . . . . . . . . . . . . . . . . . . .   x
  276.  
  277.                                                                          ii
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.                                    DISCLAIMER
  296.                                    ----------
  297.  
  298.      This software is provided without any guarantee, either expressed or
  299.      implied.  All responsibilities for its use rest with the user of the
  300.      software and not the author.
  301.  
  302.  
  303.                                    USER NOTICE
  304.                                    -----------
  305.  
  306.      This software is distributed as a shareware product.  You may try this
  307.      software at no charge.  If you do use this software package or any part
  308.      of it in writing door applications you are required to register it.
  309.  
  310.      This software may be distributed provided that none of the software
  311.      has been modified or omitted.  Distribution is limited to those who
  312.      distribute software at no charge with a copying and mailing charge not
  313.      to exceed $5.
  314.  
  315.  
  316.  
  317.                                 LICENSE AGREEMENT
  318.                                 -----------------
  319.  
  320.      Although not a requirement, I would appreciate if you would include the
  321.      following line as part of your game signon:
  322.  
  323.             I/O and BBS functions provided by the Mycroft DM library.
  324.  
  325.      Thanks and have fun.
  326.  
  327.  
  328.